home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / gdb.new / gdb-4.0 / bfd / doc / reloc.p < prev    next >
Encoding:
Text File  |  1991-09-29  |  5.4 KB  |  253 lines
  1. /* bfd_perform_relocation
  2. The relocation routine returns as a status an enumerated type:
  3. */
  4.  
  5. typedef enum bfd_reloc_status {
  6. /* No errors detected
  7. */
  8.  
  9.   bfd_reloc_ok,
  10.  
  11. /*
  12. The relocation was performed, but there was an overflow.
  13. */
  14.  
  15.   bfd_reloc_overflow,
  16.  
  17. /*
  18. The address to relocate was not within the section supplied
  19. */
  20.  
  21.   bfd_reloc_outofrange,
  22.  
  23. /*
  24. Used by special functions
  25. */
  26.  
  27.   bfd_reloc_continue,
  28.  
  29. /*
  30. Unused 
  31. */
  32.  
  33.   bfd_reloc_notsupported,
  34.  
  35. /*
  36. Unsupported relocation size requested. 
  37. */
  38.  
  39.   bfd_reloc_other,
  40.  
  41. /*
  42. The symbol to relocate against was undefined.
  43. */
  44.  
  45.   bfd_reloc_undefined,
  46.  
  47. /*
  48. The relocation was performed, but may not be ok - presently generated
  49. only when linking i960 coff files with i960 b.out symbols.
  50. */
  51.  
  52.   bfd_reloc_dangerous
  53.    }
  54.  bfd_reloc_status_enum_type;
  55.  
  56. /*
  57. */
  58.  
  59. typedef struct reloc_cache_entry 
  60. {
  61.  
  62. /*
  63. A pointer into the canonical table of pointers 
  64. */
  65.  
  66.   struct symbol_cache_entry **sym_ptr_ptr;
  67.  
  68. /*
  69. offset in section                 
  70. */
  71.  
  72.   rawdata_offset address;
  73.  
  74. /*
  75. addend for relocation value        
  76. */
  77.  
  78.   bfd_vma addend;    
  79.  
  80. /*
  81. if sym is null this is the section 
  82. */
  83.  
  84.   struct sec *section;
  85.  
  86. /*
  87. Pointer to how to perform the required relocation
  88. */
  89.  
  90.   CONST struct reloc_howto_struct *howto;
  91. } arelent;
  92.  
  93. /*
  94.  
  95.  reloc_howto_type
  96. The @code{reloc_howto_type} is a structure which contains all the
  97. information that BFD needs to know to tie up a back end's data.
  98. */
  99.  
  100. typedef CONST struct reloc_howto_struct 
  101. { 
  102. /* The type field has mainly a documetary use - the back end can to what
  103. it wants with it, though the normally the back end's external idea of
  104. what a reloc number would be would be stored in this field. For
  105. example, the a PC relative word relocation in a coff environment would
  106. have the type 023 - because that's what the outside world calls a
  107. R_PCRWORD reloc.
  108. */
  109.  
  110.   unsigned int type;
  111.  
  112. /*
  113. The value the final relocation is shifted right by. This drops
  114. unwanted data from the relocation. 
  115. */
  116.  
  117.   unsigned int rightshift;
  118.  
  119. /*
  120. The size of the item to be relocated - 0, is one byte, 1 is 2 bytes, 3
  121. is four bytes.
  122. */
  123.  
  124.   unsigned int size;
  125.  
  126. /*
  127. Now obsolete
  128. */
  129.  
  130.   unsigned int bitsize;
  131.  
  132. /*
  133. Notes that the relocation is relative to the location in the data
  134. section of the addend. The relocation function will subtract from the
  135. relocation value the address of the location being relocated.
  136. */
  137.  
  138.   boolean pc_relative;
  139.  
  140. /*
  141. Now obsolete
  142. */
  143.  
  144.   unsigned int bitpos;
  145.  
  146. /*
  147. Now obsolete
  148. */
  149.  
  150.   boolean absolute;
  151.  
  152. /*
  153. Causes the relocation routine to return an error if overflow is
  154. detected when relocating.
  155. */
  156.  
  157.   boolean complain_on_overflow;
  158.  
  159. /*
  160. If this field is non null, then the supplied function is called rather
  161. than the normal function. This allows really strange relocation
  162. methods to be accomodated (eg, i960 callj instructions).
  163. */
  164.  
  165.   bfd_reloc_status_enum_type (*special_function)();
  166.  
  167. /*
  168. The textual name of the relocation type.
  169. */
  170.  
  171.   char *name;
  172.  
  173. /*
  174. When performing a partial link, some formats must modify the
  175. relocations rather than the data - this flag signals this.
  176. */
  177.  
  178.   boolean partial_inplace;
  179.  
  180. /*
  181. The src_mask is used to select what parts of the read in data are to
  182. be used in the relocation sum. Eg, if this was an 8 bit bit of data
  183. which we read and relocated, this would be 0x000000ff. When we have
  184. relocs which have an addend, such as sun4 extended relocs, the value
  185. in the offset part of a relocating field is garbage so we never use
  186. it. In this case the mask would be 0x00000000.
  187. */
  188.  
  189.   bfd_word src_mask;
  190. /* The dst_mask is what parts of the instruction are replaced into the
  191. instruction. In most cases src_mask == dst_mask, except in the above
  192. special case, where dst_mask would be 0x000000ff, and src_mask would
  193. be 0x00000000.
  194. */
  195.  
  196.   bfd_word dst_mask;           
  197.  
  198. /*
  199. When some formats create PC relative instructions, they leave the
  200. value of the pc of the place being relocated in the offset slot of the
  201. instruction, so that a PC relative relocation can be made just by
  202. adding in an ordinary offset (eg sun3 a.out). Some formats leave the
  203. displacement part of an instruction empty (eg m88k bcs), this flag
  204. signals the fact.
  205. */
  206.  
  207.   boolean pcrel_offset;
  208. } reloc_howto_type;
  209.  
  210. /*
  211.  
  212.  HOWTO
  213. The HOWTO define is horrible and will go away.
  214. */
  215. #define HOWTO(C, R,S,B, P, BI, ABS, O, SF, NAME, INPLACE, MASKSRC, MASKDST, PC) \
  216.   {(unsigned)C,R,S,B, P, BI, ABS,O,SF,NAME,INPLACE,MASKSRC,MASKDST,PC}
  217.  
  218. /*
  219.  
  220.  reloc_chain
  221. */
  222. typedef unsigned char bfd_byte;
  223.  
  224. typedef struct relent_chain {
  225.   arelent relent;
  226.   struct   relent_chain *next;
  227. } arelent_chain;
  228.  
  229. /*
  230.  
  231. If an output_bfd is supplied to this function the generated image
  232. will be relocatable, the relocations are copied to the output file
  233. after they have been changed to reflect the new state of the world.
  234. There are two ways of reflecting the results of partial linkage in an
  235. output file; by modifying the output data in place, and by modifying
  236. the relocation record. Some native formats (eg basic a.out and basic
  237. coff) have no way of specifying an addend in the relocation type, so
  238. the addend has to go in the output data.  This is no big deal since in
  239. these formats the output data slot will always be big enough for the
  240. addend. Complex reloc types with addends were invented to solve just
  241. this problem.
  242. */
  243.  PROTO(bfd_reloc_status_enum_type,
  244.                 bfd_perform_relocation,
  245.                         (bfd * abfd,
  246.                         arelent *reloc_entry,
  247.                         PTR data,
  248.                         asection *input_section,
  249.                         bfd *output_bfd));
  250.  
  251. /*
  252. */
  253.